<html>
<head>
<title>
Date - Helma Javascript Reference
</title>

<meta http-equiv="Content-Script-Type" content="text/javascript">
<script src="scripts.js"></script>
<link rel="stylesheet" href="styles.css" media="screen" />
    <script src="http://www.google-analytics.com/urchin.js" type="text/javascript"></script>
    <script type="text/javascript">_uacct = "UA-737027-2";urchinTracker();</script>
<style>
td {
    font-family: "Trebuchet MS", sans-serif; 
    font-size: 13px; 
    line-height:135%;
}
.columnheight {
    height: 1350px;
}
</style>
</head>
<body bgcolor="white">

<div class="frame">

<img class="home" onclick="location='http://dev.helma.org/'" src="helmaheader.gif" /><br />
<div class="lead">
    <p>Detailed reference of prototypes, properties and methods available in the <br />
    Javascript environment of your Helma web applications.</p>
</div>

<script> openbox('content') </script>


    <div class="content">
        <div class="docs">
        
            <!--
            <div class="sectionHead">Library: Date.js</div>
            -->
            <div class="section overview">
            <!--
                <div class="itemTitle">
                    Overview
                </div>
            -->
                <div>   
                    <div class="desc">Fields and methods of the jala.Date class.</div>
                    <div class="itemTags">
            <!--
                    <ul>
                        
                    
                    </ul>
            -->
                    </div>
                </div>
            </div>
            
            <!--
            <div class="sectionHead">Constructors</div>
            -->
            
            
            <div class="section constructor">
                <div class="itemTitle">
                    <a name="jala.Date"></a>
                    
                    
                        <i><a href="#jala" class="type">jala</a>
                        <span class="symbolname">Date</span>(<span class="signature"></span>)</i>
                    
                    
                    
                </div>
                
                
                    <div class="desc">Constructs a new Renderings object.</div>
                
                
                
                
                
                
                
                
                
                
                <div class="detailHead">methods</div>
                
                    <ul class="details">
                        <li><a href="#jala.Date.renderEditor">renderEditor</a>(prefix, date, fmt)</li>
                    </ul>
                
                    <ul class="details">
                        <li><a href="#jala.Date.renderEditorAsString">renderEditorAsString</a>(prefix, date, pattern)</li>
                    </ul>
                
                
                
                
                
                
                
                

                

            </div>
            
            
            
            
            
            
            
            <div class="section constructor">
                <div class="itemTitle">
                    <a name="jala.Date.Calendar"></a>
                    
                    
                        <i><a href="#jala" class="type">jala</a>
                        <span class="symbolname">Date.Calendar</span>(<span class="signature">collection</span>)</i>
                    
                    
                    
                </div>
                
                
                    <div class="desc">Creates a new instance of jala.Data.Calendar</div>
                
                
                
                
                
                
                
                
                <div class="detailHead">parameters</div>
                <table class="params">
                
                    <tr>
                        <td class="type">
                            HopObject
                        </td>
                        <td>
                            collection
                        </td>
                        <td>
                            A grouped HopObject collection to work on
                        </td> 
                    </tr>
                
                </table>
                
                
                
                <div class="detailHead">methods</div>
                
                    <ul class="details">
                        <li><a href="#jala.Date.Calendar.getCollection">getCollection</a>()</li>
                    </ul>
                
                    <ul class="details">
                        <li><a href="#jala.Date.Calendar.setRenderer">setRenderer</a>(r)</li>
                    </ul>
                
                    <ul class="details">
                        <li><a href="#jala.Date.Calendar.getRenderer">getRenderer</a>()</li>
                    </ul>
                
                    <ul class="details">
                        <li><a href="#jala.Date.Calendar.setLocale">setLocale</a>(loc)</li>
                    </ul>
                
                    <ul class="details">
                        <li><a href="#jala.Date.Calendar.getLocale">getLocale</a>()</li>
                    </ul>
                
                    <ul class="details">
                        <li><a href="#jala.Date.Calendar.setTimeZone">setTimeZone</a>(loc)</li>
                    </ul>
                
                    <ul class="details">
                        <li><a href="#jala.Date.Calendar.getTimeZone">getTimeZone</a>()</li>
                    </ul>
                
                    <ul class="details">
                        <li><a href="#jala.Date.Calendar.setHrefFormat">setHrefFormat</a>(fmt)</li>
                    </ul>
                
                    <ul class="details">
                        <li><a href="#jala.Date.Calendar.getHrefFormat">getHrefFormat</a>()</li>
                    </ul>
                
                    <ul class="details">
                        <li><a href="#jala.Date.Calendar.setAccessNameFormat">setAccessNameFormat</a>(fmt)</li>
                    </ul>
                
                    <ul class="details">
                        <li><a href="#jala.Date.Calendar.getAccessNameFormat">getAccessNameFormat</a>()</li>
                    </ul>
                
                    <ul class="details">
                        <li><a href="#jala.Date.Calendar.render">render</a>(today)</li>
                    </ul>
                
                    <ul class="details">
                        <li><a href="#jala.Date.Calendar.getCalendar">getCalendar</a>(today)</li>
                    </ul>
                
                
                
                
                
                
                
                

                

            </div>
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            <div class="section constructor">
                <div class="itemTitle">
                    <a name="jala.Date.Calendar.Renderer"></a>
                    
                    
                        <i><a href="#jala" class="type">jala</a>
                        <span class="symbolname">Date.Calendar.Renderer</span>(<span class="signature">calendar</span>)</i>
                    
                    
                    
                </div>
                
                
                    <div class="desc">Returns a new instance of the default calendar renderer.</div>
                
                
                
                
                
                
                
                
                <div class="detailHead">parameters</div>
                <table class="params">
                
                    <tr>
                        <td class="type">
                            jala.Date.Calendar
                        </td>
                        <td>
                            calendar
                        </td>
                        <td>
                            The calendar utilizing this renderer
                        </td> 
                    </tr>
                
                </table>
                
                
                
                <div class="detailHead">methods</div>
                
                    <ul class="details">
                        <li><a href="#jala.Date.Calendar.Renderer.renderDayHeader">renderDayHeader</a>(text)</li>
                    </ul>
                
                    <ul class="details">
                        <li><a href="#jala.Date.Calendar.Renderer.renderRow">renderRow</a>(row)</li>
                    </ul>
                
                    <ul class="details">
                        <li><a href="#jala.Date.Calendar.Renderer.renderDay">renderDay</a>(date, isExisting, isSelected)</li>
                    </ul>
                
                    <ul class="details">
                        <li><a href="#jala.Date.Calendar.Renderer.renderPrevNextLink">renderPrevNextLink</a>(date)</li>
                    </ul>
                
                    <ul class="details">
                        <li><a href="#jala.Date.Calendar.Renderer.renderCalendar">renderCalendar</a>(date, body, prevMonth, nextMonth)</li>
                    </ul>
                
                
                
                
                <div class="detailHead">properties</div>
                
                    <ul class="details">
                        <li><span class="type">helma.Html</span> <a href="#jala.Date.Calendar.Renderer.html">html</a></li>
                    </ul>
                
                    <ul class="details">
                        <li><span class="type">jala.Date.Calendar</span> <a href="#jala.Date.Calendar.Renderer.calendar">calendar</a></li>
                    </ul>
                
                
                
                
                
                

                

            </div>
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            <!--
            <div class="sectionHead">Namespaces</div>
            -->
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            <!--
            <div class="sectionHead">Properties</div>
            -->
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            <div class="section object">
                <div class="itemTitle">
                    <a name="jala.Date.Calendar.Renderer.html"></a>
                    
                    <span class="type">helma.Html</span>
                    
                    
                    
                        <i><a href="#jala.Date.Calendar.Renderer" class="type">jala.Date.Calendar.Renderer</a>.
                        <span class="symbolname">html</span></i>
                    
                    
                    
                </div>
                
                
                    <div class="desc">An instance of helma.Html used for rendering the calendar</div>
                
                
                
                
                
                
                

                <!-- if test="symbol.properties.length">
                <div class="detailHead">properties</div>
                <table class="params">
                
                </table>
                </if -->
            </div>
            
            
            
            
            <div class="section object">
                <div class="itemTitle">
                    <a name="jala.Date.Calendar.Renderer.calendar"></a>
                    
                    <span class="type">jala.Date.Calendar</span>
                    
                    
                    
                        <i><a href="#jala.Date.Calendar.Renderer" class="type">jala.Date.Calendar.Renderer</a>.
                        <span class="symbolname">calendar</span></i>
                    
                    
                    
                </div>
                
                
                    <div class="desc">The calendar utilizing this renderer instance</div>
                
                
                
                
                
                
                

                <!-- if test="symbol.properties.length">
                <div class="detailHead">properties</div>
                <table class="params">
                
                </table>
                </if -->
            </div>
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            <div class="section object">
                <div class="itemTitle">
                    <a name="jala.date"></a>
                    
                    <span class="type">jala.Date</span>
                    
                    
                    
                        <i><a href="#jala" class="type">jala</a>.
                        <span class="symbolname">date</span></i>
                    
                    
                    
                </div>
                
                
                    <div class="desc">Default date class instance.</div>
                
                
                
                
                
                
                

                <!-- if test="symbol.properties.length">
                <div class="detailHead">properties</div>
                <table class="params">
                
                </table>
                </if -->
            </div>
            
            
            

            <!--
            <div class="sectionHead">Constructors</div>
            -->
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            <div class="sectionHead">Methods</div>
            
            
            
            
            <div class="section function">
                <div class="itemTitle">
                    <a name="jala.Date.renderEditor"></a>
                    
                    
                        <i><a href="#jala.Date" class="type">jala.Date</a>.
                        <span class="symbolname">renderEditor</span>(<span class="signature">prefix, date, fmt</span>)</i>
                    
                    
                    
                </div>
                
                
                    <div class="desc">Renders a timestamp as set of DropDown boxes, following the
format passed as argument. Every &lt;select&gt;
item is prefixed with a string so that it can be retrieved
easily from the values of a submitted POST request.</div>
                

                
                
                
                
                
                <div class="detailHead">parameters</div>
                <table class="params">
                
                    <tr>
                        <td class="type">
                            String
                        </td>
                        <td>
                            prefix
                        </td>
                        <td>
                            The prefix to use for all dropdown boxes, eg. "postdate"
                        </td> 
                    </tr>
                
                    <tr>
                        <td class="type">
                            Date
                        </td>
                        <td>
                            date
                        </td>
                        <td>
                            A Date object to use as preselection (optional)
                        </td> 
                    </tr>
                
                    <tr>
                        <td class="type">
                            Object
                        </td>
                        <td>
                            fmt
                        </td>
                        <td>
                            Array containing one parameter object for every single
select box that should be rendered, with the following properties set:
<ul>
<li>pattern - The date format pattern that should be rendered. Valid
patterns are: "dd", "MM", "yyyy", "HH", "ss".</li>
<li>firstOption - The string to use as first option, eg.: "choose a day"</li>
</ul>
                        </td> 
                    </tr>
                
                </table>
                
                
                
                
                

                

            </div>
            
            
            
            <div class="section function">
                <div class="itemTitle">
                    <a name="jala.Date.renderEditorAsString"></a>
                    
                    
                        <i><a href="#jala.Date" class="type">jala.Date</a>.
                        <span class="symbolname">renderEditorAsString</span>(<span class="signature">prefix, date, pattern</span>)</i>
                    
                    
                    
                </div>
                
                
                    <div class="desc">Returns a timestamp as set of dropdown-boxes</div>
                

                
                
                
                
                
                <div class="detailHead">parameters</div>
                <table class="params">
                
                    <tr>
                        <td class="type">
                            
                        </td>
                        <td>
                            prefix
                        </td>
                        <td>
                            
                        </td> 
                    </tr>
                
                    <tr>
                        <td class="type">
                            
                        </td>
                        <td>
                            date
                        </td>
                        <td>
                            
                        </td> 
                    </tr>
                
                    <tr>
                        <td class="type">
                            
                        </td>
                        <td>
                            pattern
                        </td>
                        <td>
                            
                        </td> 
                    </tr>
                
                </table>
                
                
                
                
                

                
                <div class="detailHead">see</div>
                <table class="params">
                
                    <tr><td class="type"><div class="see"><a href="jala.Date.html#jala.Date.renderEditor">jala.Date.renderEditor</a></div></td></tr>
                
                </table>
                

            </div>
            
            
            
            
            
            <div class="section function">
                <div class="itemTitle">
                    <a name="jala.Date.Calendar.getCollection"></a>
                    
                    
                        <i><a href="#jala.Date.Calendar" class="type">jala.Date.Calendar</a>.
                        <span class="symbolname">getCollection</span>(<span class="signature"></span>)</i>
                    
                    
                    
                </div>
                
                
                    <div class="desc">Returns the collection this calendar object works on</div>
                

                
                
                
                
                
                
                
                <div class="detailHead">returns</div>
                <table class="params">
                
                    <tr>
                        <td class="type">
                            
                        </td>
                        <td>
                            The HopObject collection of this calendar
                        </td> 
                    </tr>
                
                </table>
                
                
                

                

            </div>
            
            
            
            <div class="section function">
                <div class="itemTitle">
                    <a name="jala.Date.Calendar.setRenderer"></a>
                    
                    
                        <i><a href="#jala.Date.Calendar" class="type">jala.Date.Calendar</a>.
                        <span class="symbolname">setRenderer</span>(<span class="signature">r</span>)</i>
                    
                    
                    
                </div>
                
                
                    <div class="desc">Sets the renderer to use.</div>
                

                
                
                
                
                
                <div class="detailHead">parameters</div>
                <table class="params">
                
                    <tr>
                        <td class="type">
                            Object
                        </td>
                        <td>
                            r
                        </td>
                        <td>
                            The renderer to use
                        </td> 
                    </tr>
                
                </table>
                
                
                
                
                

                
                <div class="detailHead">see</div>
                <table class="params">
                
                    <tr><td class="type"><div class="see"><a href="jala.Date.Calendar.html#jala.Date.Calendar.getRenderer">jala.Date.Calendar.getRenderer</a></div></td></tr>
                
                </table>
                

            </div>
            
            
            
            <div class="section function">
                <div class="itemTitle">
                    <a name="jala.Date.Calendar.getRenderer"></a>
                    
                    
                        <i><a href="#jala.Date.Calendar" class="type">jala.Date.Calendar</a>.
                        <span class="symbolname">getRenderer</span>(<span class="signature"></span>)</i>
                    
                    
                    
                </div>
                
                
                    <div class="desc">Returns the renderer used by this calendar.</div>
                

                
                
                
                
                
                
                
                <div class="detailHead">returns</div>
                <table class="params">
                
                    <tr>
                        <td class="type">
                            
                        </td>
                        <td>
                            The calendar renderer
                        </td> 
                    </tr>
                
                </table>
                
                
                

                
                <div class="detailHead">see</div>
                <table class="params">
                
                    <tr><td class="type"><div class="see"><a href="jala.Date.Calendar.html#jala.Date.Calendar.setRenderer">jala.Date.Calendar.setRenderer</a></div></td></tr>
                
                </table>
                

            </div>
            
            
            
            <div class="section function">
                <div class="itemTitle">
                    <a name="jala.Date.Calendar.setLocale"></a>
                    
                    
                        <i><a href="#jala.Date.Calendar" class="type">jala.Date.Calendar</a>.
                        <span class="symbolname">setLocale</span>(<span class="signature">loc</span>)</i>
                    
                    
                    
                </div>
                
                
                    <div class="desc">Sets the locale to use within this calendar object</div>
                

                
                
                
                
                
                <div class="detailHead">parameters</div>
                <table class="params">
                
                    <tr>
                        <td class="type">
                            java.util.Locale
                        </td>
                        <td>
                            loc
                        </td>
                        <td>
                            The locale to use
                        </td> 
                    </tr>
                
                </table>
                
                
                
                
                

                
                <div class="detailHead">see</div>
                <table class="params">
                
                    <tr><td class="type"><div class="see"><a href="jala.Date.Calendar.html#jala.Date.Calendar.getLocale">jala.Date.Calendar.getLocale</a></div></td></tr>
                
                </table>
                

            </div>
            
            
            
            <div class="section function">
                <div class="itemTitle">
                    <a name="jala.Date.Calendar.getLocale"></a>
                    
                    
                        <i><a href="#jala.Date.Calendar" class="type">jala.Date.Calendar</a>.
                        <span class="symbolname">getLocale</span>(<span class="signature"></span>)</i>
                    
                    
                    
                </div>
                
                
                    <div class="desc">Returns the locale used within this calendar instance.  By default
the locale used by this calendar is the default locale of the
Java Virtual Machine running Helma.</div>
                

                
                
                
                
                
                
                
                <div class="detailHead">returns</div>
                <table class="params">
                
                    <tr>
                        <td class="type">
                            
                        </td>
                        <td>
                            The locale of this calendar
                        </td> 
                    </tr>
                
                </table>
                
                
                

                
                <div class="detailHead">see</div>
                <table class="params">
                
                    <tr><td class="type"><div class="see"><a href="jala.Date.Calendar.html#jala.Date.Calendar.setLocale">jala.Date.Calendar.setLocale</a></div></td></tr>
                
                </table>
                

            </div>
            
            
            
            <div class="section function">
                <div class="itemTitle">
                    <a name="jala.Date.Calendar.setTimeZone"></a>
                    
                    
                        <i><a href="#jala.Date.Calendar" class="type">jala.Date.Calendar</a>.
                        <span class="symbolname">setTimeZone</span>(<span class="signature">loc</span>)</i>
                    
                    
                    
                </div>
                
                
                    <div class="desc">Sets the locale to use within this calendar object</div>
                

                
                
                
                
                
                <div class="detailHead">parameters</div>
                <table class="params">
                
                    <tr>
                        <td class="type">
                            java.util.Locale
                        </td>
                        <td>
                            loc
                        </td>
                        <td>
                            The locale to use
                        </td> 
                    </tr>
                
                </table>
                
                
                
                
                

                
                <div class="detailHead">see</div>
                <table class="params">
                
                    <tr><td class="type"><div class="see"><a href="jala.Date.Calendar.html#jala.Date.Calendar.getTimeZone">jala.Date.Calendar.getTimeZone</a></div></td></tr>
                
                </table>
                

            </div>
            
            
            
            <div class="section function">
                <div class="itemTitle">
                    <a name="jala.Date.Calendar.getTimeZone"></a>
                    
                    
                        <i><a href="#jala.Date.Calendar" class="type">jala.Date.Calendar</a>.
                        <span class="symbolname">getTimeZone</span>(<span class="signature"></span>)</i>
                    
                    
                    
                </div>
                
                
                    <div class="desc">Returns the locale used within this calendar instance. By default
the timezone used by this calendar is the default timezone
of the Java Virtual Machine running Helma.</div>
                

                
                
                
                
                
                
                
                <div class="detailHead">returns</div>
                <table class="params">
                
                    <tr>
                        <td class="type">
                            
                        </td>
                        <td>
                            The locale of this calendar
                        </td> 
                    </tr>
                
                </table>
                
                
                

                
                <div class="detailHead">see</div>
                <table class="params">
                
                    <tr><td class="type"><div class="see"><a href="jala.Date.Calendar.html#jala.Date.Calendar.setTimeZone">jala.Date.Calendar.setTimeZone</a></div></td></tr>
                
                </table>
                

            </div>
            
            
            
            <div class="section function">
                <div class="itemTitle">
                    <a name="jala.Date.Calendar.setHrefFormat"></a>
                    
                    
                        <i><a href="#jala.Date.Calendar" class="type">jala.Date.Calendar</a>.
                        <span class="symbolname">setHrefFormat</span>(<span class="signature">fmt</span>)</i>
                    
                    
                    
                </div>
                
                
                    <div class="desc">Sets the format of the hrefs to render by this calendar
to the format pattern passed as argument.</div>
                

                
                
                
                
                
                <div class="detailHead">parameters</div>
                <table class="params">
                
                    <tr>
                        <td class="type">
                            String
                        </td>
                        <td>
                            fmt
                        </td>
                        <td>
                            The date format pattern to use for
rendering the href
                        </td> 
                    </tr>
                
                </table>
                
                
                
                
                

                
                <div class="detailHead">see</div>
                <table class="params">
                
                    <tr><td class="type"><div class="see"><a href="jala.Date.Calendar.html#jala.Date.Calendar.getHrefFormat">jala.Date.Calendar.getHrefFormat</a></div></td></tr>
                
                </table>
                

            </div>
            
            
            
            <div class="section function">
                <div class="itemTitle">
                    <a name="jala.Date.Calendar.getHrefFormat"></a>
                    
                    
                        <i><a href="#jala.Date.Calendar" class="type">jala.Date.Calendar</a>.
                        <span class="symbolname">getHrefFormat</span>(<span class="signature"></span>)</i>
                    
                    
                    
                </div>
                
                
                    <div class="desc">Returns the date formatting pattern used to render hrefs. The default
format is "yyyyMMdd".</div>
                

                
                
                
                
                
                
                
                <div class="detailHead">returns</div>
                <table class="params">
                
                    <tr>
                        <td class="type">
                            
                        </td>
                        <td>
                            The date formatting pattern
                        </td> 
                    </tr>
                
                </table>
                
                
                

                
                <div class="detailHead">see</div>
                <table class="params">
                
                    <tr><td class="type"><div class="see"><a href="jala.Date.Calendar.html#jala.Date.Calendar.setHrefFormat">jala.Date.Calendar.setHrefFormat</a></div></td></tr>
                
                </table>
                

            </div>
            
            
            
            <div class="section function">
                <div class="itemTitle">
                    <a name="jala.Date.Calendar.setAccessNameFormat"></a>
                    
                    
                        <i><a href="#jala.Date.Calendar" class="type">jala.Date.Calendar</a>.
                        <span class="symbolname">setAccessNameFormat</span>(<span class="signature">fmt</span>)</i>
                    
                    
                    
                </div>
                
                
                    <div class="desc">Sets the format of the group name to use when trying to access
child objects of the collection this calendar is operating on.</div>
                

                
                
                
                
                
                <div class="detailHead">parameters</div>
                <table class="params">
                
                    <tr>
                        <td class="type">
                            String
                        </td>
                        <td>
                            fmt
                        </td>
                        <td>
                            The date format pattern to use for
accessing child objects
                        </td> 
                    </tr>
                
                </table>
                
                
                
                
                

                
                <div class="detailHead">see</div>
                <table class="params">
                
                    <tr><td class="type"><div class="see"><a href="jala.Date.Calendar.html#jala.Date.Calendar.getAccessNameFormat">jala.Date.Calendar.getAccessNameFormat</a></div></td></tr>
                
                </table>
                

            </div>
            
            
            
            <div class="section function">
                <div class="itemTitle">
                    <a name="jala.Date.Calendar.getAccessNameFormat"></a>
                    
                    
                        <i><a href="#jala.Date.Calendar" class="type">jala.Date.Calendar</a>.
                        <span class="symbolname">getAccessNameFormat</span>(<span class="signature"></span>)</i>
                    
                    
                    
                </div>
                
                
                    <div class="desc">Returns the format of the access name used by this calendar to access
child group objects of the collection this calendar is operating on.
The default format is "yyyyMMdd".</div>
                

                
                
                
                
                
                
                
                <div class="detailHead">returns</div>
                <table class="params">
                
                    <tr>
                        <td class="type">
                            
                        </td>
                        <td>
                            The date formatting pattern used to access child objects
                        </td> 
                    </tr>
                
                </table>
                
                
                

                
                <div class="detailHead">see</div>
                <table class="params">
                
                    <tr><td class="type"><div class="see"><a href="jala.Date.Calendar.html#jala.Date.Calendar.setAccessNameFormat">jala.Date.Calendar.setAccessNameFormat</a></div></td></tr>
                
                </table>
                

            </div>
            
            
            
            <div class="section function">
                <div class="itemTitle">
                    <a name="jala.Date.Calendar.render"></a>
                    
                    
                        <i><a href="#jala.Date.Calendar" class="type">jala.Date.Calendar</a>.
                        <span class="symbolname">render</span>(<span class="signature">today</span>)</i>
                    
                    
                    
                </div>
                
                
                    <div class="desc">Renders the calendar using either a custom renderer defined
using {@link #setRenderer} or the default one.</div>
                

                
                
                
                
                
                <div class="detailHead">parameters</div>
                <table class="params">
                
                    <tr>
                        <td class="type">
                            
                        </td>
                        <td>
                            today
                        </td>
                        <td>
                            
                        </td> 
                    </tr>
                
                </table>
                
                
                
                
                

                
                <div class="detailHead">see</div>
                <table class="params">
                
                    <tr><td class="type"><div class="see"><a href="jala.Date.Calendar.html#jala.Date.Calendar.setRenderer">jala.Date.Calendar.setRenderer</a></div></td></tr>
                
                    <tr><td class="type"><div class="see"><a href="jala.Date.html#jala.Date.Calendar.Renderer">jala.Date.Calendar.Renderer</a></div></td></tr>
                
                </table>
                

            </div>
            
            
            
            <div class="section function">
                <div class="itemTitle">
                    <a name="jala.Date.Calendar.getCalendar"></a>
                    
                    
                        <i><a href="#jala.Date.Calendar" class="type">jala.Date.Calendar</a>.
                        <span class="symbolname">getCalendar</span>(<span class="signature">today</span>)</i>
                    
                    
                    
                </div>
                
                
                    <div class="desc">Returns a rendered calendar</div>
                

                
                
                
                
                
                <div class="detailHead">parameters</div>
                <table class="params">
                
                    <tr>
                        <td class="type">
                            
                        </td>
                        <td>
                            today
                        </td>
                        <td>
                            
                        </td> 
                    </tr>
                
                </table>
                
                
                
                
                

                
                <div class="detailHead">see</div>
                <table class="params">
                
                    <tr><td class="type"><div class="see"><a href="jala.Date.Calendar.html#jala.Date.Calendar.renderCalendar">jala.Date.Calendar.renderCalendar</a></div></td></tr>
                
                </table>
                

            </div>
            
            
            
            
            
            
            
            
            
            <div class="section function">
                <div class="itemTitle">
                    <a name="jala.Date.Calendar.Renderer.renderDayHeader"></a>
                    
                    
                        <i><a href="#jala.Date.Calendar.Renderer" class="type">jala.Date.Calendar.Renderer</a>.
                        <span class="symbolname">renderDayHeader</span>(<span class="signature">text</span>)</i>
                    
                    
                    
                </div>
                
                
                    <div class="desc">Renders a single cell in the calendar day header row directly to response.</div>
                

                
                
                
                
                
                <div class="detailHead">parameters</div>
                <table class="params">
                
                    <tr>
                        <td class="type">
                            String
                        </td>
                        <td>
                            text
                        </td>
                        <td>
                            The text to display in the header field.
                        </td> 
                    </tr>
                
                </table>
                
                
                
                
                

                

            </div>
            
            
            
            <div class="section function">
                <div class="itemTitle">
                    <a name="jala.Date.Calendar.Renderer.renderRow"></a>
                    
                    
                        <i><a href="#jala.Date.Calendar.Renderer" class="type">jala.Date.Calendar.Renderer</a>.
                        <span class="symbolname">renderRow</span>(<span class="signature">row</span>)</i>
                    
                    
                    
                </div>
                
                
                    <div class="desc">Renders a single calendar row directly to response.</div>
                

                
                
                
                
                
                <div class="detailHead">parameters</div>
                <table class="params">
                
                    <tr>
                        <td class="type">
                            String
                        </td>
                        <td>
                            row
                        </td>
                        <td>
                            The body of the calendar row.
                        </td> 
                    </tr>
                
                </table>
                
                
                
                
                

                

            </div>
            
            
            
            <div class="section function">
                <div class="itemTitle">
                    <a name="jala.Date.Calendar.Renderer.renderDay"></a>
                    
                    
                        <i><a href="#jala.Date.Calendar.Renderer" class="type">jala.Date.Calendar.Renderer</a>.
                        <span class="symbolname">renderDay</span>(<span class="signature">date, isExisting, isSelected</span>)</i>
                    
                    
                    
                </div>
                
                
                    <div class="desc">Renders a single day within the calendar directly to response.</div>
                

                
                
                
                
                
                <div class="detailHead">parameters</div>
                <table class="params">
                
                    <tr>
                        <td class="type">
                            Date
                        </td>
                        <td>
                            date
                        </td>
                        <td>
                            A date instance representing the day within the calendar.
                        </td> 
                    </tr>
                
                    <tr>
                        <td class="type">
                            Boolean
                        </td>
                        <td>
                            isExisting
                        </td>
                        <td>
                            True if there is a child object in the calendar's
collection to which the date cell should link to
                        </td> 
                    </tr>
                
                    <tr>
                        <td class="type">
                            Boolean
                        </td>
                        <td>
                            isSelected
                        </td>
                        <td>
                            True if this calendar day should be rendered
as selected day.
                        </td> 
                    </tr>
                
                </table>
                
                
                
                
                

                

            </div>
            
            
            
            <div class="section function">
                <div class="itemTitle">
                    <a name="jala.Date.Calendar.Renderer.renderPrevNextLink"></a>
                    
                    
                        <i><a href="#jala.Date.Calendar.Renderer" class="type">jala.Date.Calendar.Renderer</a>.
                        <span class="symbolname">renderPrevNextLink</span>(<span class="signature">date</span>)</i>
                    
                    
                    
                </div>
                
                
                    <div class="desc">Renders a link to the previous or next month's calendar directly to response.</div>
                

                
                
                
                
                
                <div class="detailHead">parameters</div>
                <table class="params">
                
                    <tr>
                        <td class="type">
                            Date
                        </td>
                        <td>
                            date
                        </td>
                        <td>
                            A date object set to the previous or next available
month. This can be null in case there is no previous or next month.
                        </td> 
                    </tr>
                
                </table>
                
                
                
                
                

                

            </div>
            
            
            
            <div class="section function">
                <div class="itemTitle">
                    <a name="jala.Date.Calendar.Renderer.renderCalendar"></a>
                    
                    
                        <i><a href="#jala.Date.Calendar.Renderer" class="type">jala.Date.Calendar.Renderer</a>.
                        <span class="symbolname">renderCalendar</span>(<span class="signature">date, body, prevMonth, nextMonth</span>)</i>
                    
                    
                    
                </div>
                
                
                    <div class="desc">Renders the calendar directly to response.</div>
                

                
                
                
                
                
                <div class="detailHead">parameters</div>
                <table class="params">
                
                    <tr>
                        <td class="type">
                            Date
                        </td>
                        <td>
                            date
                        </td>
                        <td>
                            A date object representing this calendar's month and year.
Please mind that the day will be set to the <em>last</em> date in this
month.
                        </td> 
                    </tr>
                
                    <tr>
                        <td class="type">
                            String
                        </td>
                        <td>
                            body
                        </td>
                        <td>
                            The rendered calendar weeks including the day header
(basically the whole kernel of the table).
                        </td> 
                    </tr>
                
                    <tr>
                        <td class="type">
                            Date
                        </td>
                        <td>
                            prevMonth
                        </td>
                        <td>
                            A date object set to the last available date of
the previous month. This can be used to render a navigation link to
the previous month.
                        </td> 
                    </tr>
                
                    <tr>
                        <td class="type">
                            Date
                        </td>
                        <td>
                            nextMonth
                        </td>
                        <td>
                            A date object set to the first available date
of the next month. This can be used to render a navigation link to
the next month.
                        </td> 
                    </tr>
                
                </table>
                
                
                
                
                

                

            </div>
            
            
            
            
            
        </div>
    </div>
    <div class="finePrint">
    Fri, 05 Feb 2010 17:40:06 GMT.
    </div>

<script> closebox() </script>

<script> openbox('pageintro') </script>

    <h3>core framework</h3>
        <ul>            
            <li><a href="global.html">global</a></li>
            <li><a href="app.html">app (application)</a></li>
            <li><a href="req.html">req (request)</a></li>
            <li><a href="res.html">res (response)</a></li>
            <li><a href="session.html">session</a></li>
            <li><a href="global.html#path">path</a></li>
            <li><a href="global.html#root">root</a></li>
            <li><a href="HopObject.html">HopObject</a></li>
            <li><a href="User.html">User</a></li>
            <li><a href="File.html">File</a></li>
            <li><a href="FtpClient.html">FtpClient</a></li>
            <li><a href="Image.html">Image</a></li>
            <li><a href="Mail.html">Mail</a></li>
            <li><a href="global.html#Remote">Remote</a></li>
            <li><a href="Xml.html">Xml</a></li>
            <li><a href="DatabaseObject.html">DatabaseObject</a></li>
            <li><a href="MimePart.html">MimePart</a></li>
            <li><a href="Skin.html">Skin</a></li>
            <li><a href="global.html#Object.dontEnum">Object</a></li>
        </ul>
        
    <h3>optional modules</h3>
        <ul>            
            <li><a href="ArrayExtensions.html">Array extensions</a></li>
            <li><a href="DateExtensions.html">Date extensions</a></li>
            <li><a href="NumberExtensions.html">Number extensions</a></li>
            <li><a href="ObjectExtensions.html">Object extensions</a></li>
            <li><a href="StringExtensions.html">String extensions</a></li>
            <li><a href="HopObjectExtensions.html">HopObject extensions</a></li>
            <li><a href="GlobalMacros.html">global macros</a></li>
            <li><a href="MacroFilters.html">macro filters</a></li>
            <li><a href="JSON.html">JSON methods</a></li>
            <br />
            <li><a href="helma.Aspects.html">helma.Aspects</a></li>
            <li><a href="helma.Chart.html">helma.Chart</a></li>
            <li><a href="helma.Color.html">helma.Color</a></li>
            <li><a href="helma.Database.html">helma.Database</a></li>
            <li><a href="helma.File.html">helma.File</a></li>
            <li><a href="helma.Ftp.html">helma.Ftp</a></li>
            <li><a href="helma.Group.html">helma.Group</a></li>
            <li><a href="helma.Html.html">helma.Html</a></li>
            <li><a href="helma.Http.html">helma.Http</a></li>
            <li><a href="helma.Image.html">helma.Image</a></li>
            <li><a href="helma.Mail.html">helma.Mail</a></li>
            <li><a href="helma.Search.html">helma.Search</a></li>
            <li><a href="helma.Skin.html">helma.Skin</a></li>
            <li><a href="helma.Ssh.html">helma.Ssh</a></li>
            <li><a href="helma.Url.html">helma.Url</a></li>
            <li><a href="helma.Zip.html">helma.Zip</a></li>
            <br />
            <li><a href="jala.BitTorrent.html">jala.BitTorrent</a></li>
            <li><a href="jala.Captcha.html">jala.Captcha</a></li>
            <li><a href="jala.Date.html">jala.Date</a></li>
            <li><a href="jala.db.html">jala.db</a></li>
            <li><a href="jala.DnsClient.html">jala.DnsClient</a></li>
            <li><a href="jala.Form.html">jala.Form</a></li>
            <li><a href="jala.History.html">jala.History</a></li>
            <li><a href="jala.HopObjectExtensions.html">jala HopObject extensions</a></li>
            <li><a href="jala.HtmlDocument.html">jala.HtmlDocument</a></li>
            <li><a href="jala.I18n.html">jala.I18n</a></li>
            <li><a href="jala.ImageFilter.html">jala.ImageFilter</a></li>
            <li><a href="jala.IndexManager.html">jala.IndexManager</a></li>
            <li><a href="jala.ListRenderer.html">jala.ListRenderer</a></li>
            <li><a href="jala.Mp3.html">jala.Mp3</a></li>
            <li><a href="jala.PodcastWriter.html">jala.PodcastWriter</a></li>
            <li><a href="jala.RemoteContent.html">jala.RemoteContent</a></li>
            <li><a href="jala.Rss20Writer.html">jala.Rss20Writer</a></li>
            <li><a href="jala.Utilities.html">jala.Utilities</a></li>
            <li><a href="jala.XmlRpcRequest.html">jala.XmlRpcRequest</a></li>
            <li><a href="jala.XmlWriter.html">jala.XmlWriter</a></li>
        </ul>
    
    <h3>java libraries</h3>
        <ul>            
            <li><a href="http://www.docjar.org/">docjar search</a></li>
        </ul>

    <h3>properties files</h3>
        <ul>            
            <li><a href="http://dev.helma.org/docs/Properties+Files/apps.properties/">apps.properties</a></li>
            <li><a href="http://dev.helma.org/docs/Properties+Files/app.properties/">app.properties</a></li>
            <li><a href="http://dev.helma.org/docs/Properties+Files/server.properties/">server.properties</a></li>
            <li><a href="http://dev.helma.org/docs/Properties+Files/db.properties/">db.properties</a></li>
            <li><a href="http://dev.helma.org/docs/Properties+Files/class.properties/">class.properties</a></li>
            <li><a href="http://dev.helma.org/docs/Type.properties+Documentation/">type.properties</a></li>
         </ul>
    
<script> closebox() </script>

</div>
<br clear="all" /><br /><br />



</body>
</html>
